Skip to content

feat: adds support for self in overlay#322

Open
baywet wants to merge 8 commits intoOAI:mainfrom
baywet:feat/self-support
Open

feat: adds support for self in overlay#322
baywet wants to merge 8 commits intoOAI:mainfrom
baywet:feat/self-support

Conversation

@baywet
Copy link
Copy Markdown
Member

@baywet baywet commented Apr 13, 2026

fixes #310

heavy use of GCC to put this one together. (based on the discussion in the issue, and the arazzo PR as a template)

Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet baywet self-assigned this Apr 13, 2026
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet baywet requested a review from handrews April 14, 2026 13:55
Comment thread versions/1.2.0-dev.md Outdated
baywet added 3 commits April 15, 2026 12:53
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet baywet requested a review from handrews April 15, 2026 17:04
@baywet baywet marked this pull request as ready for review April 21, 2026 15:15
@baywet baywet requested a review from a team as a code owner April 21, 2026 15:15
Copy link
Copy Markdown
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is getting quite close! BTW, I have only had time to review the markdown file, I hope someone else can look at the tests and schemas, and just ping me if there are questions you can't resolve.

Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Comment thread versions/1.2.0-dev.md Outdated
Co-authored-by: Vincent Biret <vincentbiret@hotmail.com>
Comment thread versions/1.2.0-dev.md
Implementations MUST NOT treat an `extends` value as unresolvable before checking all possible target [[OpenAPI]] Description documents provided to the implementation.

To ensure interoperability, when a target [[OpenAPI]] Description defines `$self`, the Overlay's `extends` value MUST match the target's `$self` URI.
To ensure portability, when a target [[OpenAPI]] Description defines `$self`, the Overlay's `extends` value SHOULD match the target's `$self` URI.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[I also apologize for failing to hit send on this two days ago]

I apologize for not noticing this earlier, but I'm not sure "interoperability" is the ideal word here.

This is really more about portability (of the documents) than interoperability. Given the same input, implementations would be expected to resolve the references the same way. I suppose this is a bit more interoperable as implementations might have different ways to figure out the current document's location for resolving a relative extends, but... hmm... I think this is more about portability of document sets. idk, does anyone else think "interoperability" is better here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

portability works great! I believe we have already applied the suggestion, anything else?

Comment thread versions/1.2.0-dev.md
@baywet baywet requested a review from handrews April 29, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The extends field should support referencing OADs by their $self

2 participants